home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / AmigaTalk / help / AddedPrimitives.doc next >
Encoding:
Text File  |  1998-08-22  |  16.0 KB  |  411 lines
  1. /****h *AmigaTalk/AddedPrimitives.doc [1.5] ************************
  2. **
  3. ** Herein is described the Primitives added by moi.
  4. **
  5. ********************************************************************
  6. */
  7.  
  8. /*     Primitive 159 is not used by the original system code,
  9. **     therefore it will be used to send Class & Method info to
  10. **     the Main program listview gadgets in ATWnd 
  11. */
  12.  
  13. /*     Primitives 180 - 189 are for Intuition: */
  14.  
  15. /*     Screen  primitives:                                  */
  16.  
  17. 180 0  titlestring                                       -- CloseScreen
  18. 180 1  screentype titlestring                            -- OpenScreen
  19. 180 2  getwhichpart titlestring                          -- GetScreenPart
  20. 180 3  setwhichpart whatvalue titlestring                -- SetScreenPart
  21. 180 4  FuncName titlestring                              -- ExecScreenFunc
  22. 180 5  num_lines titlestring                             -- PullScreenUp
  23. 180 6  num_lines titlestring                             -- PushScreenDown
  24. 180 7  titlestring                                       -- RedrawScreen
  25. 180 8  titlestring                                       -- ReOpenScreen
  26. 180 9  screentype titlestring                            -- AllocateScreen
  27.  
  28. ScreenType: 32-bit integer that describes the DisplayModeID
  29.             WARNING!! There is no error checking done on this number.
  30.                
  31. GetWhichPart:  0 = LeftEdge, 1 = TopEdge, 2 = Width, 3 = Height, 
  32.                4 = DetailPen, 5 = BlockPen, 6 = Flags, 7 = *Font, 8 = *Title,
  33.                9 = Depth, 10 = ViewModes, 11 = Type, 12 = *BitMapName.
  34.  
  35. SetWhichPart:  0 = LeftEdge, 1 = TopEdge, 2 = Width, 3 = Height, 
  36.                4 = DetailPen, 5 = BlockPen, 7 = *Font, 8 = *Title, 
  37.                9 = Depth, 10 = ViewModes, 11 = Type, 12 = *BitMapName.
  38.  
  39. WhatValue:  integer or string ONLY!!
  40.  
  41. FuncName:   DisplayBeep, ScreenToBack, ScreenToFront, TurnOffTitle, 
  42.             ShowTitle.
  43.  
  44. /*     Window primitives:                                   */
  45.  
  46. 181 0  windowtitle                                       -- CloseWindow
  47. 181 1  screentitle windowtitle                           -- OpenWindow
  48. 181 2  getwhichpart windowtitle                          -- GetWindowPart
  49. 181 3  setwhichpart whatvalue windowtitle                -- SetWindowPart
  50. 181 4  FuncName0 windowtitle                             -- ExecWindowFunc0
  51. 181 5  FuncName1 Arg1 windowtitle                        -- ExecWindowFunc1
  52. 181 6  FuncName2 Arg1 Arg2 windowtitle                   -- ExecWindowFunc2
  53. 181 7  bodytext postext negtext width height windowtitle -- AutoRequest
  54. 181 8  spritename height width xoff yoff windowtitle     -- SetPointer
  55. 181 9  gadgetname type windowtitle                       -- AddGadget
  56. 181 10 gadgetname type windowtitle                       -- RemoveGadget
  57. 181 11 TRUE | FALSE windowtitle                          -- ReportMouse
  58. 181 12 oldtitle newtitle                                 -- ChangeTitle
  59. 181 13 screentitle windowtitle                           -- AllocateWindow
  60. 181 14 itextname xoffset yoffset windowtitle             -- PrintIText
  61. 181 15 windowtitle                                       -- ReOpenWindow
  62. 181 16 windowtitle                                       -- Handle_Intuition
  63.  
  64. GetWhichPart:  0 = LeftEdge, 1 = TopEdge, 2 = Width, 3 = Height, 
  65.                4 = DetailPen, 5 = BlockPen, 6 = Flags, 7 = IDCMPFlags, 
  66.                8 = MouseX, 9 = MouseY, 10 = *Title, 11 = ReqCount, 
  67.                12 = PtrWidth, 13 = PrtHeight, 14 = XOffset, 15 = YOffset, 
  68.                16 = *ScreenTitle.
  69.                
  70. SetWhichPart:  0 = LeftEdge, 1 = TopEdge, 2 = Width, 3 = Height, 
  71.                4 = DetailPen, 5 = BlockPen, 6 = Flags, 7 = IDCMPFlags,
  72.                8 = MinWidth, 9 = MinHeight, 10 = MaxWidth, 11 = MaxHeight,
  73.                12 = *1stGadgetName, 13 = *CheckMarkImageName,
  74.                14 = *BitMapName.
  75.                
  76. WhatValue:  integer or string ONLY!!.
  77.  
  78. FuncName0:  BeginRefresh, EndRefresh, RemakeDisplay, RethinkDisplay, 
  79.             RemoveDMRequest, WindowToBack, WindowToFront, RemoveMenuStrip,
  80.             RefreshGadgets.
  81.  
  82. FuncName1:  ShowRequester( RequesterName ), AddDMRequest( DMRequesterName ), 
  83.             AddMenuStrip( MenuName ).
  84.  
  85. FuncName2:  MoveWindow( DeltaX, DeltaY ), SetWindowSize( DeltaX, DeltaY).
  86.             
  87. Type:       0 = Boolean, 1 = String, 2 = Proportional.            
  88.            
  89.  
  90. /*                       Menu primitives:                   */
  91.  
  92. 182 0  type menuname                                     -- RemoveM
  93. 182 1  type menuname                                     -- AddM
  94. 182 2  whichpart type menuname                           -- GetPartM
  95. 182 3  whichpart whatvalue type menuname                 -- SetPartM
  96. 182 4  windowtitle menuname                              -- SetParent
  97.  
  98. Type:       0 = Menu, 1 = MenuItem & 2 = SubItem.
  99.  
  100. For Menus,
  101. WhichPart:  0 = LeftEdge,  1 = TopEdge, 2 = Width, 3 = Height, 4 = Flags, 
  102.             8 = *NextMenu, 9 = *FirstItem,
  103.             
  104.             Only for GetPartM:
  105.  
  106.             13 = *MenuName.
  107.  
  108.  
  109. For MenuItems & SubItems,
  110.  
  111. WhichPart:  0 = LeftEdge, 1 = TopEdge, 2 = Width, 3 = Height, 4 = Flags, 
  112.             5 = MutualExclude, 6 = Command, 7 = *NextItem,
  113.             9 = *FirstItem, 10 = *ItemFill, 11 = *SelectFill, 12 = *SubItem.
  114.  
  115. WhatValue:  integer or string ONLY!!
  116.  
  117.  
  118. /*                        Gadget primitives:                */
  119.  
  120. 183 0 type gadgetname                                    -- RemoveGadget
  121. 183 1 type gadgetname                                    -- AddGadget
  122. 183 2 type whichpart gadgetname                          -- GetGadgetPart
  123. 183 3 type whichpart whatvalue gadgetname                -- SetGadgetPart
  124. 183 4 flags hpot vpot hbody vbody windtitle gadgetname   -- ModifyProp
  125. 183 5 newsize gadgetname                                 -- ChangeBufferSize
  126. 183 6 flags hpot vpot hbody vbody gadgetname             -- SetPropValues
  127. 183 7 type windowtitle gadgetname                        -- SetParent
  128.  
  129. WhichPart:  0  = LeftEdge, 1 = TopEdge, 2 = Width, 3 = Height, 4 = Flags,
  130.             5  = Activation, 6 = GadgetType, 7 = GadgetID, 
  131.             8  = *NextGadgetName, 9 = *GadgetITextName, 10 = *RenderName,
  132.             11 = *SelectName, 12 = BufferSize, 13 = PropFlags,
  133.             14 = HPot, 15 = VPot, 16 = HBody, 17 = VBody.
  134.             
  135. Type:  0 = Boolean, 1 = String, 2 = Proportional.
  136.  
  137.  
  138. /*                   Color Register primitives:          */               
  139. 184 0 cmapname colorsavefile                             -- FreeColorMap
  140. 184 1 cmapname numberofcolors                            -- GetColorMap
  141. 184 2 windowtitle numberofcolors colorfile               -- LoadRGB4
  142. 184 3 type source whichentry                             -- GetRGB4
  143. 184 4 windowtitle whichentry red green blue              -- SetRGB4
  144. 184 5 type source whichentry red green blue              -- SetRGB4CM
  145. 184 6 source destination sourcetype                      -- CopyMap
  146. 184 7 windowTitle ColorSaveFile                          -- SaveRGBs
  147.  
  148. Type:           0 = ColorMapName, 1 = WindowTitle
  149. Source:         ColorMapName or WindowTitle
  150. NumberOfColors: a power of 2 range: 2 to ??? (currently 32)
  151. ColorFile:      variable number of UWORDS.
  152.  
  153.  
  154. /*                   Requester primitives:        */
  155.  
  156. 185 0 requestername                            -- RemoveRequester
  157. 185 1 requestername                            -- AddRequester
  158. 185 2 whichpart requestername                  -- GetRequesterPart
  159. 185 3 whichpart whatvalue requestername        -- SetRequesterPart
  160. 185 4 gadgetname requestername                 -- SetParent
  161.  
  162. WhichPart:  0 = LeftEdge, 1 = TopEdge, 2 = Width, 3 = Height,
  163.             4 = RelLeft, 5 = RelTop, 6 = Flags, 7 = BackFill, 
  164.             8 = *ReqText, 9 = *gadgetname, 10 = *bordername, 
  165.             11 = *bitmapname.
  166.  
  167.  
  168. /*                   Alert     primitives:              */
  169.  
  170. 186 0 alertname                                      -- RemoveAlert
  171. 186 1 alertnumber alertheight alertstring alertname  -- AddAlert
  172. 186 2 whichpart alertname                            -- GetAlertPart
  173. 186 3 whichpart whatvalue alertname                  -- SetAlertPart
  174. 186 4 alertname                                      -- AlertDisplay
  175.  
  176. alertstring is 128 characters maximum & will get the alertnumber will
  177. be pre-pended to it.
  178.  
  179.  
  180. /*                   Border    primitives:        */
  181.  
  182. 187 0 bordername                               -- RemoveBorder
  183. 187 1 num_pts bordername                       -- AddBorder
  184. 187 2 whichpart bordername                     -- GetBorderPart
  185. 187 3 whichpart whatvalue bordername           -- SetBorderPart
  186. 187 4 whichpoint newx newy bordername          -- SetBorderPoint
  187. 187 5 windowTitle bordername                   -- SetParent
  188.  
  189. WhichPart:  0 = LeftEdge, 1 = TopEdge, 2 = FrontPen, 3 = BackPen,
  190.             4 = DrawMode, 5 = Count, 6 = *NextBorderName.
  191.             
  192.  
  193. /*                   IText & Font primitives:     */
  194.  
  195. 188 0 itextname                                -- RemoveIText
  196. 188 1 textstring itextname                     -- AddIText
  197. 188 2 whichpart itextname                      -- GetITextPart
  198. 188 3 whichpart whatvalue itextname            -- SetITextPart
  199. 188 4 fontname                                 -- RemoveFont
  200. 188 5 fontname                                 -- AddFont
  201. 188 6 whichfontpart fontname                   -- GetFontPart
  202. 188 7 whichfontpart whatfontvalue fontname     -- SetFontPart
  203. 188 8 windowtitle itextname                    -- SetParent
  204. 188 9 itextname                                -- GetTextLength
  205.  
  206. WhichPart:  0 = FrontPen, 1 = BackPen, 2 = DrawMode, 3 = LeftEdge,
  207.             4 = TopEdge, 5 = *ITextFontName, 6 = *IText, 7 = *NextTextname.
  208.  
  209. WhichFontPart:  0 = ta_Name, 1 = ta_YSize, 2 = ta_Style, 3 = ta_Flags
  210.  
  211. WhatValue:      Integers only!!
  212.  
  213. WhatFontVlaue:  Integers or a FontName string.
  214.                    
  215.  
  216. /*                   BitMap primitives:           */
  217.  
  218. 189 0                     bitmapname           -- RemoveBitMap
  219. 189 1 Width Height Depth  bitmapname           -- AddBitMap
  220. 189 2 WhichPart           bitmapname           -- GetBitMapPart
  221. 189 3 WhichPart WhatValue bitmapname           -- SetBitMapPart
  222. 189 4 datafilename        bitmapname           -- SetBitMapData
  223. 189 5 datafilename        bitmapname           -- WriteBitMap
  224.  
  225. WhichPart:  0 = BytesPerRow, 1 = Rows, 2 = Flags, 3 = Depth
  226.  
  227.  
  228. 190 0 libname                                  -- CloseLibrary
  229. 190 1 libname                                  -- OpenLibrary
  230.  
  231. 191                                            -- Ports
  232. 192                                            -- Tasks
  233. 193                                            -- Processes
  234. 194                                            -- Memory
  235. 195                                            -- Lists
  236. 196                                            -- Interrupts
  237. 197                                            -- Semaphores
  238. 198                                            -- Signals
  239. 199                                            -- Exceptions
  240.  
  241. /* Simple Graphics primitives: */
  242.  
  243. 200 0 windowtitle pen#                                     -- SetAPen
  244. 200 1 windowtitle pen#                                     -- SetBPen
  245. 200 2 windowtitle pen#                                     -- SetOPen
  246. 200 3 windowtitle mode                                     -- SetDrMd
  247. 200 4 windowtitle x y                                      -- Move
  248. 200 5 windowtitle x y                                      -- Draw
  249. 200 6 windowtitle x1 y1 x2 y2                              -- DrawLine
  250. 200 7 windowtitle x1 y1 x2 y2                              -- DrawBox
  251. 200 8 windowtitle x y radius                               -- DrawCircle
  252. 200 9 windowtitle x y r1 r2                                -- DrawEllipse
  253. 200 10 windowtitle bordername                              -- DrawPolygon
  254. 200 11 windowtitle x y                                     -- WritePixel
  255. 200 12 windowtitle imagename                               -- RemoveImage
  256. 200 13 windowtitle width height depth imagename            -- AddImage
  257. 200 14 windowtitle whichpart imagename                     -- GetImagePart
  258. 200 15 windowtitle whichpart whatvalue imagename           -- SetImagePart
  259. 200 16 windowtitle xoffset yoffset imagename               -- DrawImage
  260. 200 17 windowtitle datafilename imagename                  -- SetImagedata
  261. 200 18 windowtitle imagename                               -- SetImageParent
  262.  
  263. WhichPart:  0 = LeftEdge, 1 = TopEdge, 2 = WIdth, 3 = Height, 4 = Depth,
  264.             5 = *ImageData, 6 = PlanePick, 7 = PlaneOnOff, 8 = *NextImage.
  265.  
  266.             
  267. /* Area Graphics primitives: */
  268.  
  269. 201                                            -- Area
  270. 202                                            -- ViewPorts
  271. 203                                            -- Views
  272. 204                                            -- PlayFields
  273. 205                                            -- RastPorts
  274. 206                                            -- RasInfo
  275. 207                                            -- Layers
  276. 208                                            -- Blitter
  277. 209                                            -- Copper         
  278.  
  279. /* ARexx primitives: */
  280.  
  281. 210 
  282. 211
  283. 212
  284. 213
  285. 214
  286. 215
  287. 216
  288. 217
  289. 218
  290. 219
  291.  
  292. /* Device primitives: */
  293.  
  294. 220 0 cmd channel# channelname  -- ActOnAudioChannel
  295. 220 1 cmd narratorname          -- ActOnNarrator
  296. 221   cmd clipboardname         -- ActOnClipboard
  297. 222 0 cmd consolename           -- ActOnConsole
  298. 222 1 cmd keyboardname          -- ActOnKeyboard
  299. 223 0 cmd gameportname          -- ActOnGamePort
  300. 223 1 cmd inputname             -- ActOnInput
  301. 224   cmd parallelname          -- ActOnParallel
  302. 225   cmd printername           -- ActOnPrinter
  303. 226   cmd SCSIname              -- ActOnSCSI
  304.  
  305. 227 0 buffersize    serialname          -- CloseSerial
  306. 227 1 buffersize    serialname          -- OpenSerial
  307. 227 2 breakchars    serialname          -- InitSerial
  308. 227 3 sync          serialname          -- ReadSerial
  309. 227 4 string        serialname          -- WriteSerial
  310. 227 5               serialname          -- ResetSerial
  311. 227 6               serialname          -- PauseSerial
  312. 227 7               serialname          -- RestartSerial
  313. 227 8 usec_duration serialname          -- SendBreak
  314. 227 9               serialname          -- GetStatus
  315. 227 10              serialname          -- FlushSerial
  316. 227 11              serialname          -- ClearReadBuffer
  317. 227 12 sync                             -- SetSyncType
  318. 227 13 0 baud         serialname        -- SetBaud       -:
  319. 227 13 1 datasize     serialname        -- SetDataSize    |
  320. 227 13 2 #stops       serialname        -- SetStops        \
  321. 227 13 3 duration     serialname        -- SetBreakLength   > SetParameter
  322. 227 13 4 rbufsize     serialname        -- SetRBuffSize    /
  323. 227 13 5 newflags     serialname        -- SetFlags       |
  324. 227 14 termchars      serialname        -- SetTerminators
  325. 227 15 parityType On|Off serialname     -- SetParity
  326.  
  327. parityType: 0 = Space, 1 = Mark, 2 = Even & 3 = Odd.
  328. On|Off:     0 = Off,  >0 = On 
  329. sync:       0 = No Sync, >0 = Sync
  330. breakchars = termchars = 8 bytes in descending order representing the
  331.                          characters that the serial channel should 
  332.                          recognize as EOF characters. 
  333.  
  334. All commands (except Read & Write) use BeginIO with IOF_QUICK set, regardless
  335. of the state of the SyncType.
  336.  
  337.  
  338. 228   cmd timevalue timername   -- ActOnTimer
  339. 229   cmd trackdiskname         -- ActOnTrackdisk
  340.  
  341. /* Animation Graphics primitives: */
  342.  
  343. 230 
  344. 231
  345. 232
  346. 233
  347. 234
  348. 235
  349. 236
  350. 237
  351. 238
  352. 239
  353.  
  354. /*     IFF primitives:  240 through 244:    */
  355.  
  356. 240 0 IFFName            -- CloseIFF
  357. 240 1 IFFName            -- OpenIFF
  358. 240 2                    -- FreeIFF
  359. 240 3                    -- AllocIFF
  360.  
  361. 241 0 InitIFF
  362. 241 1 InitIFFasDOS
  363. 241 2 InitIFFasClip
  364.  
  365. 242 0 OpenClipboard
  366. 242 1 ParseIFF
  367. 242 2 ReadChunkBytes
  368. 242 3 ReadChunkRecords
  369. 242 4 StopChunk
  370. 242 5 CurrentChunk
  371. 242 6 PropChunk
  372. 242 7 FindProp
  373. 242 8 CollectionChunk
  374. 242 9 FindCollection
  375. 242 10 StopOnExit
  376. 242 11 EntryHandler
  377. 242 12 ExitHandler
  378.  
  379. 243 0 PushChunk
  380. 243 1 PopChunk
  381. 243 2 ParentChunk
  382.  
  383. 244 0 AllocLocalItem
  384. 244 1 LocalItemData
  385. 244 2 StoreLocalItem
  386. 244 3 StoreItemInContext
  387. 244 4 FindPropContext
  388. 244 5 FindLocalItem
  389. 244 6 FreeLocalItem
  390. 244 7 SetLocalItemPurge
  391.  
  392. /*    GadTools primitives:  245                    */
  393.  
  394. 245   
  395.  
  396. /*    AmigaDOS primitives:  246                    */
  397.  
  398. 246
  399.  
  400. /* Unassigned: */
  401.  
  402. 247
  403. 248
  404. 249
  405. 250
  406. 251
  407. 252
  408. 253
  409. 254
  410. 255
  411.